<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: PersistentSocketConnection.html 926 2014-09-17 03:05:56Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.net;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.IOException;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.net.Socket;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.net.SocketAddress;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>/**<a name="line.14"></a>
<span class="sourceLineNo">015</span> * Maintains a persistent {@link Socket} connection to a remote server, automatically reconnecting when the connection fails.<a name="line.15"></a>
<span class="sourceLineNo">016</span> *<a name="line.16"></a>
<span class="sourceLineNo">017</span> * &lt;p&gt;<a name="line.17"></a>
<span class="sourceLineNo">018</span> * Subclasses need only override {@link #handleConnection handleConnection()}.<a name="line.18"></a>
<span class="sourceLineNo">019</span> * &lt;/p&gt;<a name="line.19"></a>
<span class="sourceLineNo">020</span> */<a name="line.20"></a>
<span class="sourceLineNo">021</span>public abstract class PersistentSocketConnection extends PersistentConnection&lt;Socket&gt; {<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>    private SocketAddress serverAddress;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>// Properties<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>    /**<a name="line.27"></a>
<span class="sourceLineNo">028</span>     * Get the address to which this instance should connect.<a name="line.28"></a>
<span class="sourceLineNo">029</span>     */<a name="line.29"></a>
<span class="sourceLineNo">030</span>    public SocketAddress getServerAddress() {<a name="line.30"></a>
<span class="sourceLineNo">031</span>        return this.serverAddress;<a name="line.31"></a>
<span class="sourceLineNo">032</span>    }<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    /**<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * Configure the address to which this instance should connect.<a name="line.35"></a>
<span class="sourceLineNo">036</span>     *<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * &lt;p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * Required property.<a name="line.38"></a>
<span class="sourceLineNo">039</span>     * &lt;/p&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span>     */<a name="line.40"></a>
<span class="sourceLineNo">041</span>    public void setServerAddress(SocketAddress serverAddress) {<a name="line.41"></a>
<span class="sourceLineNo">042</span>        this.serverAddress = serverAddress;<a name="line.42"></a>
<span class="sourceLineNo">043</span>    }<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>// Lifecycle<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>    @Override<a name="line.47"></a>
<span class="sourceLineNo">048</span>    public void start() {<a name="line.48"></a>
<span class="sourceLineNo">049</span>        if (this.serverAddress == null)<a name="line.49"></a>
<span class="sourceLineNo">050</span>            throw new IllegalArgumentException("no serverAddress configured");<a name="line.50"></a>
<span class="sourceLineNo">051</span>        super.start();<a name="line.51"></a>
<span class="sourceLineNo">052</span>    }<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>    /**<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * Create a new server connection.<a name="line.55"></a>
<span class="sourceLineNo">056</span>     *<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * &lt;p&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * The implementation in {@link PersistentSocketConnection} creates a socket via {@link #createSocket}<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * and connects the socket to the configured server.<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * &lt;/p&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span>     */<a name="line.61"></a>
<span class="sourceLineNo">062</span>    @Override<a name="line.62"></a>
<span class="sourceLineNo">063</span>    protected Socket createConnection() throws InterruptedException, IOException {<a name="line.63"></a>
<span class="sourceLineNo">064</span>        final Socket socket = this.createSocket();<a name="line.64"></a>
<span class="sourceLineNo">065</span>        socket.connect(this.serverAddress);<a name="line.65"></a>
<span class="sourceLineNo">066</span>        return socket;<a name="line.66"></a>
<span class="sourceLineNo">067</span>    }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>    /**<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * Perform cleanup after a server connection ends.<a name="line.70"></a>
<span class="sourceLineNo">071</span>     *<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * &lt;p&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * The implementation in {@link PersistentSocketConnection} ensures the socket is closed.<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * &lt;/p&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span>     *<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * @param socket socket returned from {@link #createConnection} when this connection was created<a name="line.76"></a>
<span class="sourceLineNo">077</span>     */<a name="line.77"></a>
<span class="sourceLineNo">078</span>    @Override<a name="line.78"></a>
<span class="sourceLineNo">079</span>    protected void cleanupConnection(Socket socket) {<a name="line.79"></a>
<span class="sourceLineNo">080</span>        try {<a name="line.80"></a>
<span class="sourceLineNo">081</span>            socket.close();<a name="line.81"></a>
<span class="sourceLineNo">082</span>        } catch (IOException e) {<a name="line.82"></a>
<span class="sourceLineNo">083</span>            // ignore<a name="line.83"></a>
<span class="sourceLineNo">084</span>        }<a name="line.84"></a>
<span class="sourceLineNo">085</span>    }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    /**<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * Create the {@link Socket} to use for a new connection. The socket should &lt;b&gt;not&lt;/b&gt; be connected yet.<a name="line.88"></a>
<span class="sourceLineNo">089</span>     *<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * &lt;p&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * The implementation in {@link PersistentSocketConnection} creates a normal {@link Socket} and sets the keep-alive flag<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * to ensure connection failures are detected promptly. Subclasses may override to configure the socket differently.<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * &lt;/p&gt;<a name="line.93"></a>
<span class="sourceLineNo">094</span>     */<a name="line.94"></a>
<span class="sourceLineNo">095</span>    protected Socket createSocket() throws IOException {<a name="line.95"></a>
<span class="sourceLineNo">096</span>        final Socket socket = new Socket();<a name="line.96"></a>
<span class="sourceLineNo">097</span>        socket.setKeepAlive(true);<a name="line.97"></a>
<span class="sourceLineNo">098</span>        return socket;<a name="line.98"></a>
<span class="sourceLineNo">099</span>    }<a name="line.99"></a>
<span class="sourceLineNo">100</span>}<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>




























































</pre>
</div>
</body>
</html>
